כתיבת כתבות ומדריכים היא לא עסק קל. באיחוד כשמדובר בכתבה טכנית שדורשת הבנה טכנית מהכותב. ולא סוד שאנשים טכניים בדרך כלל מביאים את רעיונותיהם בצורה טכנית טוב יותר מאשר בכתב. עובדה זו מעידה על אפשרות שיפור לא מנוצלת בתהליך כתיבת הכתבות, עליה אני אספר.
שלבי כתיבת הכתבה
תכנון
באת התחלת תהליך כתיבת כתבה יש לענות על השאלות הבאות:
1. מה מטרת כתיבת המאמר?
2. איזו אוכלוסיה הוא משרת ומה הם הצרכים שלה?
3. לפי 1. ו2. כיצד עליו להיות כתוב? באיזה מסלול לוגי אמור לעבור הקורא?
לאחר שעניתם על שלושתם נתחיל ונבצע ניתוח לוגי של המאמר העתיד להיכתב. מומלץ לעשות זאת בעזרה תרשים זרימה פשוט. התרשים זרימה יראה בדרך כלל כך:
אם ברצונכם להתבסס להתבסס על תרשים זה, התאימו כמובן את התוכן לצורכיכם.
כלים נדרשים לכתיבת כתבה
עורך טקסט טוב (שכרגע לא כמו באתר) הוא כלי חשוב לכתיבה ויאפשר הכנסת טבלאות, תרשימים ודברים אחרים לכתבתה.
כדי לכתוב מאמר מוצלח עליכם להשתמש במספר דברים -
1. מקורות מידע קיימים, ברמה גבוהה. עדיף מספר מקורות מידע
2. IDE לכתיבת קוד מתאים
3. צילומי מסך - צייר
4. כלי לציור דיאגרמות - לדיאגרמות פשוטות אפשר את של וורד.
כתיבת הכתבה עצמה
אחרי שעברנו את כל ההכנות הגיע הזמן לכתוב את הכתבה.
כל שלב לוגי במהלך כתיבת הכתבה נסמן בכותרת משנית בגודל אחיד. רצוי שתהיה מודגשת. משחקי צבעים אסורים בהחלט.
חובה לשמור על כללי לשון נכונים. במקום "אתה היית עושה את זה?" כתבו "האם אתה היית עושה את זה?", במקום "אם עשיתם משהו לא בסדר בעת ההתחברות למסד הנתונים ואתם יכולים לתקן את זה במעוד מועד" כתבו "אם אתם עושים משהו לא בסדר בעת ההתחברות למסד הנתונים ואתם יכולים לתקן את זה במעוד מועד", במקום "אתם צריכים להחליט אם אתם עושים את זה" כתבו "אתם צריכים להחליט האם אתם עושים את זה", ובמקום "תעשו את זה כמו שצריך" כתבו "עשו את זה כמו שצריך". אלו השגיאות הנפוצות ביותר. כמובן שחייבים להקפיד על כללי כתיב ופיסוק נכונים.
כשאתם משתמשים בביטויים משפת היום יום - "סלנג", הקיפו את הביטוי במרכאות. לדוגמה - "לטרטר".
במהלך הכתבה כדאי מאד לשלב תרשימים וצילומי מסך. בכתבה תכנותית שילוב קוד הוא בדרך כלל משהו שצריכים לעשות. כשאתם משלבים קודים שקשורים לנושא מסוים השתדלו שהם לא יגלשו מעבר לתחומי הנושא, שיהיו פשוטים וקריאים , ושיכילו הערות מפורטות המסוגלות להסביר את הקוד עצמו.
הקפידו לפרט כמה שיותר עד כמה שצריך להבנה איתנה של הנושא - לרמה שלא תשאיר שאלות. לא צריך להכביד במידע אך צריך לפרט כן כמה שצריך. מומלץ לא "לטרטר" את הקורא - במקרים בהם אתם צרייכם לחסות כמות עצומה של ידע פשוט דרשו את הידע הזה כדרישה מוקדמת. למרות זאת הרבה פעמים ידע מוקדם כן צריך להציג במדריך.
יש להשתמש ברשימות במקומות בהם רצוי להציג קשר סדרתי ממוין או לא בין קבוצת היגדים. לפיכך קבעו גם את סוג הרשימה - ממוספרת או אחידה.
בטבלאות יש להשתמש במקרים יותר נדירים, אך במקום שבו צריך טבלה - מומלץ להשתמש בטבלה עם שורת / עמודת כתורת עם רקע בצבע בהיר וטקסט מודגש שיבהירו את היותה עמודת כותרת.
לאחר כתיבת המאמר
יש לעבור עליו עוד פעם ולתקן שגיאות כתיב וניסוח. במקומות בהם אתם רואים פינות שאפשר לשפר - שפרו, אל תפחדו לשנות פסקות שלמות. מומלץ להשתמש בתצוגה מקדימה.
לסיכום
כתיבת מאמר היא עבודה קשה אך משביעת רצון. אני מקווה שתשכילו לכתוב מאמרים מוצלחים ברמה גבוהה. תודה רבה על הקריאה :).
תגובות לכתבה:
אחלה מאמר, תודה. :-)
רק כמה הערות:
1. לא הייתי ממליץ על עורכי WYSIWYG (לפחות אלה שקיימים היום, כולל המובילים שבהם).
פלט ה-HTML שלהם בחלק מהפעמים לא תקני (אם כי יש לציין שאני ראיתי כמה עורכים שהתקניות שם היא לא ממש בעיה), אבל מה שכן בעיה זה למשל עיצוב טקסט; בכל העורכים שראיתי, נניח שאתה רוצה לשנות את הגופן לכמה פסקאות, במקום להכניס אותם לדיב אחד ולהוסיף לו מאפייני CSS, כל אחד מהם מקבל את זה בנפרד (שזה יכול לגרום לפעמים לשכפול קוד מסיבי ביותר).
רוב הפעמים אנחנו באמת לא רוצים להתעסק יותר מדי עם העיצוב, ופשוט פונים לסמנטיות, כך שבסופו של יום - אנחנו מוצאים את עצמנו משתמשים באפשרות לערוך את קוד ה-HTML עצמו.
(אני בטוח שיש עוד כמה בעיות, אבל לא אכתוב אותן עכשיו.)
אני מסכים עם זה שה-BBCode של האתר כרגע לא הכי טוב שיש, אבל מה שאי אפשר לעשות כרגע, אפשר להוסיף ב-HTML.
2. בקשר ל"כללי לשון" - הרעיון עצמו חשוב מאוד, אבל חצי מהדברים שם לא נכונים.
- "אתה היית עושה את זה?" ו-"האם אתה היית עושה את זה?" שניהם קבילים מבחינה לשונית, וזה עניין של הכותב איזה מהם הוא מעדיף.
- הדוגמה הבאה מראה טעות די נפוצה, אם כי לא הייתי מאשים איש אם הוא יכתוב כך. בכל מקרה, אני לא רואה שום קשר ל"במעוד מועד".
- עכשיו לך יש טעות. (אם כבר מדברים על עורכי טקסט, פה "לך" צריך להיות בתוך אלמנט em.)
"האם" משמש אך ורק למשפטים ישירים ("האם פינית את השולחן?"), ולעולם לא למשפטים עקיפים ("תגיד לי אם פינית את השולחן!").
- טעות נפוצה נוספת; ציווי. אתה בהחלט צודק, אם כי בחלק מהמקרים אני לא הייתי פועל לפי הכללים האלה מהחשש שמי שיקרא את זה לא בהכרח יבין את הפועל. "עשה" כולם מבינים (אני מקווה D:), אבל יש פעלים אחרים שלא כולם יבינו.
- פיסוק הוא אחד הדברים הכי חשובים בכתיבת מאמר, ובהרבה מאוד מאמרים אני רואה טעויות קריטיות. לכן התחלתי לכתוב את סדרת המאמרים בנושא פיסוק בבלוג שלי. אתה מוזמן לקרוא - http://bmblog.net/קטגוריות/השפה-העברית/כללי-הפיסוק/ .
3. "בטבלאות יש להשתמש במקרים יותר נדירים, אך במקום שבו צריך טבלה - מומלץ להשתמש בטבלה עם שורת / עמודת כתורת עם רקע בצבע בהיר וטקסט מודגש שיבהירו את היותה עמודת כותרת."
זה כבר נושא ב-Web Design, שאמור להימצא תחת כותרת אחרת לגמרי. (אם כי אני לא רואה שום מקום אחר להכניס את זה במאמר הזה, כך שזה סבבה. XD)
תיקון סוג-של טעות בתגובה שלי:
"במקום להכניס אותם לדיב אחד" - עוד דוגמה לבעיה סמנטית. ברוב המקרים נרצה להכניס אותם ל-<section>. אני מניח פה שבחלק המקרים דווקא section יתאים, כי זה יהיה קצת מוזר אם יהיו כמה פסקאות צמודות עם עיצוב משותף ויוצא מהכלל (משאר הפסקאות), ולא יהיה להם קשר מעבר לעיצוב.